home *** CD-ROM | disk | FTP | other *** search
/ GFX Sensations 1 / Graphic Sensations - Volume 1.iso / tools / amiga / 3d_tools / spamserv.lha / Spam-Server / Spam-Server.doc < prev    next >
Encoding:
Text File  |  1994-04-03  |  4.5 KB  |  109 lines
  1. Spam-Server v0.1 © 1994 by Dan Murrell Jr.   DanimalSoft
  2.         various code fragments and much help from Scott Ellis
  3. ------
  4.  
  5. Spam-Server is a small utility whose lone function is to alert a user by voice,
  6. beep, or print that a file has been accessed and closed by the system.  It's
  7. specific application, or why it was written in the first place, was to alert the
  8. masterful 3D artist Spamgod by voice samples that each frame of animations that he
  9. was rendering was finished.
  10.  
  11. Spam-Server features:
  12.    An appicon with the icon image user selectable.  The appicon will also be named
  13.    as the current frame Spam-Server is waiting on, and a double click of the appicon
  14.    will exit the program.
  15.    
  16.    Selectable directory for the samples.
  17.    
  18.    Selectable sample player.
  19.    
  20.    Option to use voice samples or printed output to a window.
  21.    
  22.    Option to beep the screen accompanying the voice or printed notification.
  23.  
  24.    Option to move the samples into a directory in RAM: for speed.
  25.    
  26.    Option to make the sample player resident for speed. (uses "resident <x> force")
  27.       
  28.    All options are available as either CLI arguments or icon tooltypes.
  29.    
  30. Spam-Server options:
  31.    The tooltype options are:
  32.    
  33.    SAMPLESDIR           Directory where the samples are found
  34.    SAMPLESPLAYER        Program used to play the samples
  35.    WATCHFILE            Base name of the file to watch. xxx will be appended
  36.    USEICON              Icon to be used for the appicon [do NOT put .info!]
  37.    FIRSTFRAME           [optional] first frame to wait on.  Defaults to 1
  38.    LASTFRAME            last frame to be rendered
  39.    XPOS
  40.    YPOS                 [optional] X, Y positions of the icon
  41.    DISPLAYBEEP          Beeps the screen when messages are printed/spoken
  42.    NOVOICE              No samples are played.  Output to a window that opens
  43.    RAMSAMPLES           Creates a directory RAM:Spamples/ and moves the samples there
  44.    RESPLAYER            Tries to make the player resident
  45.    
  46.    The CLI options are similar:
  47.  
  48.    SamplesDir/A,SamplesPlayer/A,WatchFile/A,UseIcon/K,XPos/K/N,YPos/K/N,
  49.    FirstFrame/K/N,LastFrame/N,DisplayBeep/S,NoVoice/S,RamSamples/S,ResPlayer/S: 
  50.  
  51.  
  52. Usage
  53. -----
  54.   Run your application, whether Lightwave, Imagine, ImageMaster, ADPro, or 
  55. whatever.  Set your arguments to Spam-Server, and run it.  It will automatically
  56. begin watching for the first frame.  Spam-Server will "tell" you when each frame
  57. is complete.  When the last frame is finished, Spam-Server will "say" that
  58. rendering is complete, and should cleanly exit.  Double-clicking it's appicon
  59. will exit at any time.
  60.  
  61.  
  62. Notes
  63. -----
  64.   Spam-Server does NOT detect the opening of the file, so even if there is some
  65. delay in the beginning of rendering a frame (from setup or somesuch), Spam-Server
  66. assumes the frame is being rendered.  
  67.  
  68.   When run more than once, Spam-Server may harrass itself, if the RESPLAYER or
  69. RAMSAMPLES options are used.  Spam-Server will create a RAM:Spamples/ directory
  70. that it deletes upon exiting (when RAMSAMPLES is used).  The original Spam-Server
  71. process is able to delete this directory.  Any subsequent Spam-Server cannot,
  72. even with the option set.  The subsequent tasks will still use the RAM:Spamples/
  73. directory, but if the original deletes the directory, there will be no samples
  74. to play.  This causes no error, but there will be no sound to play.  Any 
  75. Spam-Server is able to remove the sample player from the resident list, so only
  76. use that once.
  77.   All of that is most likely moot, unless you just like to render with more than
  78. one program and let them fight it out. :)
  79.  
  80.   There may be a problem on a 4000 if Lightwave and Spam-Server are both set to a
  81. priority of 0.  Spamgod has had this problem, but reports that it's easily fixed
  82. by setting the priority of Lightwave lower.  I've been unable to reproduce this
  83. on my system, which is not a 4000, so maybe there's something funny going on with
  84. the 4000's filesystem.  
  85.  
  86. --------
  87.  
  88.   Special thanks goes to Scott Ellis, whose Sabot program is the basis of 
  89. Spam-Server.  Much of the code is exactly the same, and he gave me a lot of help
  90. in learning how file notification works.
  91.  
  92.   Also, thanks to Linda Rosul, Spamgod's roommate, for the excellent quality 
  93. samples.
  94.  
  95. --------
  96.  
  97. Upgrades to Spam-Server are possible-- I have a couple of ideas.  If you have any
  98. feel free to make comments or suggestions.  Email to:
  99.  
  100. djm2@ra.msstate.edu
  101.  
  102. Dan Murrell Jr.
  103.  
  104.  
  105.  
  106. -----
  107. idea, icon © 1994 Chris "Spamgod" Short
  108. code © 1994 Scott "ScottE" Ellis and Dan "Danimal" Murrell Jr.
  109. with various tips, ideas, etc. from Laire, Mlelstv, Pepo, and others of #amiga